Docs: incorporate pdoc to generate API docs #182
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hi @cjrh,
This makes sense to me too. |
Sidhant29
pushed a commit
to Sidhant29/tantivy-py
that referenced
this pull request
Mar 12, 2024
…ickwit-oss#182) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Incorporating the suggestion in #174.
This is a little messy. Based on the pdoc example for Mkdocs, it seems you have to run a script to execute pdoc before the mkdocs pass. Then, because pdoc emits HTML, to get it into the mkdocs build you have to incorporate the HTML as "fake" markdown so that mkdocs will process the markdown files and incorporate it.
It works, but it's a little clunky. Here's the output on my dev machine:
There are issue with this. pdoc will use the installed tantivy module. This means that the readthedocs site will have to build the tantivy module which might turn out to be nontrivial. Instead, the pdoc execution could be done as part of CI, commiting the output markdown files (in the
./docs/apidirectory). That way, readthedocs only needs to operate on markdown files and no compilation is required.